/**
 *  Copyright (C) 2008-2013  Telosys project org. ( http://www.telosys.org/ )
 *
 *  Licensed under the GNU LESSER GENERAL PUBLIC LICENSE, Version 3.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *          http://www.gnu.org/licenses/lgpl.html
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.telosys.persistence;

/**
 * 
 * Transaction interface used to control database transactions.
 * 
 * @author Laurent GUERIN 
 *
 */
public interface PersistenceTransaction 
{
	/**
	 * Begin this transaction.  
	 * 
	 * @throws IllegalStateException if the transaction is already in progress (already active)
	 *
	 */
	void begin();

	
	/**
	 * Commit this transaction.  
	 *
	 * @throws IllegalStateException if the transaction is not in progress (not active)
	 * 
	 */
	void commit();

	
	/**
	 * Rollback this transaction.  
	 * 
	 * @throws IllegalStateException if the transaction is not in progress (not active)
	 * 
	 */
	void rollback();

	
	/**
	 * Indicates whether a transaction is in progress
	 * 
	 * @return true or false
	 */
	boolean isActive();

}
